-
Notifications
You must be signed in to change notification settings - Fork 24
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Bugfix #23 and improvements as suggested in #48 #50
Conversation
… the first file's status regardless of the next files. It now returns the most severe status (virus detected) and only 200OK if all files are clean
…calculating http status later
… security issues w/ 1.22.3
…2/scan endpoint response
I got this working on my local machine yesterday after merging the original repo's |
@davosian Do you have any insights into this issue parsing the config files? It seems lilke the version that gets installed in alpine 3.20 is 1.22.r0 which is a little bit weird considering it's not a LTS release, but a release candidate. |
Hi @arizon-dread, I finally got around going through the latest PR so that is about time get your changes merged into the project. Since you were kind enough to review PR #59, I was wondering whether your tests included the changes from this PR as well? Great to hear about your openness to support the project! As you can tell my reactions are on the slow end (which I am hoping to improve) so any support I can get to keep this project active is a very welcome change. I also just checked the version included in Alpine Edge and even there it is a release candidate (1.3.2-r0). Not sure though whether this is normal for Alpine's Edge versions. |
Hi @davosian My tests in #59 did not include my code in this PR, I tested the PR's code as it was indented to be merged (checked out the branch from @christianbumann's fork). I have now merged the Yes, the Alpine repos seems to be a bit off with the clamav versions, if you check the official clamav download page: clamav, they promote 1.4.1 LTS and 1.0.7 LTS. The 1.4.1 version is also the version on the official docker hub repo clamav dockerhub. That's why I was contemplating on if we should switch the base image to the official clamav image to get a LTS release of it instead, but if we decide to do that, I think it needs to be it's own PR from a clean fork from I'll get back tomorrow with version update results! |
…d b/c of missing repos
…natures on startup
…ript for settings management
It seems to be working as expected. I also fixed the centos.Dockerfile which was very outdated and wouldn't even build. Centos:stream8 is EOL and the repos are offline so I upgraded to stream9 and modified the dockerfile to create the folder structure used in the standard docker file to get it up and running (to match the entrypoint.sh script). The centos base image has clamav 1.0.7 in the repos so the version is slightly older. |
… in ajilach#62 which can now be closed
… in ajilach#62 which can now be closed
…into pr/arizon-dread/50
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I found that the prometheus metric no_of_found_viruses
only considers the new /v2/scan
endpoint. Is this by design?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The default for MAX_SCAN_SIZE
is 100M
, the default for MAX_FILE_SIZE
is 25M
. To me it would logically make more sense to set the default for MAX_FILE_SIZE
equal or larger than MAX_SCAN_SIZE
. Otherwise, MAX_SCAN_SIZE
would never be hit. Or am I missunderstanding something?
I have just not thought it through completely, of course, every virus hit should be recorded as an uptick, regardsless of which endpoint finds it. I initially had an Idea to build a middleware that intercepts all responses on the way back to the client and if the status code is 406, increment the prometheus counter, but after having looked into this I've realized it's not as straight forward as i initially thought. Creating a middleware in go is fairly easy but it seems that the
These seems to be the default values in the clamd.conf file out of the box. It looks like that on my machine too. I'm not sure why though. |
…no_of_found_viruses prometheus counter
I have done some late night refactoring to be more uniform in how it works with traversing the statuses, setting the correct http status and incrementing the virus found ticker. I will not be changing the response status of the scanPathHandler, it has always returned 200, I only added a check for each virus found, it will also increment the counter. The |
I checked again the defaults and usage in clamav itself:
I am still not sure why In other words: as you already pointed out @arizon-dread , we are applying the same logic as the clamav project itself and therefore we should stick to it. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I did some more testing around the old and new endpoints. The service responded as expected and the counter behaved accordingly, resetting with a fresh start of the container, honoring the MAX_FILE_SIZE
and counting up for each virus found independently of the endpoint used. Therefore, I would say, we are ready to merge this PR. 💪
Bugfix and suggestions for improvement implemented
Fixes #23 by checking for error from clamd.ScanStream, which closes the connection if the file size is exceeded. The error was previously ignored. This PR includes code that assumes that a closed connection is caused by file size exceeded. Unfortunately, there is no way to detect the ^INSTREAM: file size limit exceeded error from the clamd process in the api. A custom clamd.ScanResult is created inside the error handling if statement, to handle the response in the same switch/case logic as other responses. This is also handled in the scanHandlerBody func the same way, so the client actually get a response.
Fixes #48 by creating a new endpoint (
/v2/scan
) and a scanResult struct that contains status, description and httpStatus (httpStatus is ignored in the json annotation, and only used in the code logic). An array of all scanned files (as[]scanResult
) is then marshalled to json, creating a proper json response for one to many files, returning an array of json objects to the client. The old/scan
endpoint will also use this response (which is formatted the same way as before) but it will not be returned in an array, but as before, one to many json objects without proper json array structure, to keep previous behavior intact. Although, deprecation and link headers indicating that there's a new endpoint available, is returned from the old endpoint.Previously, the first file's status would be the http status of the entire response, this PR includes code that will always return a 406 http status if any file contains a virus, and only return a 200 OK status if all files are clean, for both the old and new endpoint. I figured this was a bug.
I also added a prometheus metrics counter that increments on each found virus.
I also added go.mod and go.sum to use go modules instead of vendor directory etc.